Cisco-IOS-XR-ip-rsvp-oper API API Reference
API generated from Cisco-IOS-XR-ip-rsvp-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{router}}/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
RSVP-STANDBY - Retrieve
Retrieve operation of resource: rsvp-standby
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-standby": { RSVP operational data for standby role
"hello-instance-briefs": { Table of brief info about hello instances
"hello-instance-brief": [
{
"source-address": "string", Source Address
"lost-communication-total": "integer",
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string",
"instance-type": "string" Hello instance type
}
]
},
"request-briefs": { Table of brief info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", output Interface
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-neighbor-details": { Table of detailed info about I/F neighbors
{
"neighbor-address": "string", Neighbor address
{
"retransmitted-messages": "integer", Count of messages retransmitted
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Count of Out of Order messages
}
],
"node-address": "string" Neighbor node address
}
]
},
"nsr": { Summary information for all RSVP NSR counters
"status": { Status of ERO
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"controller-briefs": { Table of brief info about RSVP-enabled\ncontroller
{
"controller-name": "string", Controller Name
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
},
"rsb-detaileds": { Table of detailed info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"input-adjusted-interface": "string", Input Adjusted Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"input-physical-interface": "string", Input Physical Interface
"p2mp-id": "integer", P2MP ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
]
},
"hello-interface-instance-details": { Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [
{
"last-message-sent-time": { Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
},
"global-neighbor-details": { Table of detailed info about global neighbors
{
"restart-state": "string", Restart state
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"hello-interval": "integer", Interval at which hello messages are sent
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [
{
"entry": "string"
}
]
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"restart-timer-expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"restart-time-left": {
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
"neighbor-address": "string"
"missed-hellos": "integer"
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"recovery-time": "integer"
"node-address": "string"
"is-restart-timer-running": "boolean"
"neighbor-hello-state": [
{
"entry": "string"
}
]
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
]
}
"open-config": {
"global-counters": {
"out-hello-messages": "integer"
"rate-limited-messages": "integer"
"in-reservation-messages": "integer"
"out-reservation-tear-messages": "integer"
"out-path-tear-messages": "integer"
"in-ack-messages": "integer"
"path-timeouts": "integer"
"in-srefresh-messages": "integer"
"in-reservation-tear-messages": "integer"
"out-path-error-messages": "integer"
"out-reservation-messages": "integer"
"in-reservation-error-messages": "integer"
"in-path-tear-messages": "integer"
"out-srefresh-messages": "integer"
"out-path-messages": "integer"
"in-path-messages": "integer"
"in-hello-messages": "integer"
"reservation-timeouts": "integer"
"out-ack-messages": "integer"
"in-path-error-messages": "integer"
"out-reservation-error-messages": "integer"
}
"interface-counters": {
"interface-counter": [
{
"out-ack-messages": "integer"
"in-reservation-messages": "integer"
"in-srefresh-messages": "integer"
"in-path-tear-messages": "integer"
"interface-name-xr": "string"
"in-hello-messages": "integer"
"out-reservation-tear-messages": "integer"
"out-reservation-error-messages": "integer"
"in-reservation-tear-messages": "integer"
"out-path-tear-messages": "integer"
"interface-name": "string"
"in-ack-messages": "integer"
"out-path-error-messages": "integer"
"out-reservation-messages": "integer"
"in-reservation-error-messages": "integer"
"out-srefresh-messages": "integer"
"out-path-messages": "integer"
"in-path-messages": "integer"
"out-hello-messages": "integer"
"in-path-error-messages": "integer"
}
]
}
}
"rsb-briefs": {
"rsb-brief": [
{
"destination-port": "integer"
"input-interface": "string"
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
"ipv4-uni-session": {
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
}
"session-type": "string"
"ipv4": {
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
}
"destination-address": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"source-port": "integer"
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"style": {
"reservation-type": "string"
}
"extended-tunnel-id": "string"
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
"p2mp-ipv4-session": {
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
"filter-type": "string"
}
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
"counters": {
"interface-messages": {
"interface-message": [
{
"transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"retransmitted-messages": "integer"
"interface-name": "string"
"rate-limited-messages": "integer"
"received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"out-of-order-messages": "integer"
}
]
}
"message-summary": {
"transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"retransmitted-messages": "integer"
"rate-limited-messages": "integer"
"received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"out-of-order-messages": "integer"
}
"event-syncs": {
"event-sync": [
{
"nac-ks": "integer"
"expired-paths": "integer"
"expired-reservations": "integer"
"interface-name": "string"
}
]
}
"database": {
"incoming-paths": "integer"
"sessions": "integer"
"interfaces": "integer"
"outgoing-paths": "integer"
"outgoing-reservations": "integer"
"incoming-reservations": "integer"
}
"issu": {
"total-id-ts": "integer"
"last-cleared-timestamp": "integer"
"total-states": "integer"
"last-idt-states": "integer"
"total-deletions": "integer"
"rsvp-process-role": "string"
"total-nacks": "integer"
}
"prefix-filtering": {
"interfaces": {
"interfaces": {
"interface": [
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total number of instances of this state
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", InterfaceName
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
"summary": {
"default-action-dropped": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"forwarded": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"default-action-processed": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"locally-destined": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"dropped": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"total": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
}
}
"accesses": {
"access": [
{
"access-list-name": "string"
"forwarded": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"total": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"dropped": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"locally-destined": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
"interface-events": {
"interface-event": [
{
"nac-ks": "integer"
"expired-paths": "integer"
"expired-reservations": "integer"
"interface-name": "string"
}
]
}
"nsr": {
"total-id-ts": "integer"
"last-cleared-timestamp": "integer"
"total-states": "integer"
"last-idt-states": "integer"
"total-deletions": "integer"
"rsvp-process-role": "string"
"total-nacks": "integer"
}
"out-of-resource": {
"interfaces": {
"interfaces": {
"interface": [
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" InterfaceName
}
]
}
"summary": {
"dropped-path-messages": "integer"
}
}
}
}
"controller-summaries": {
"controller-summary": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"reservations-out": "integer"
"interface-name-xr": "string"
"paths-in": "integer"
"controller-name": "string"
"reservations-in": "integer"
"paths-out": "integer"
}
]
}
"interface-briefs": {
"interface-brief": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"interface-name": "string"
"interface-name-xr": "string"
}
]
}
"session-detaileds": {
"session-detailed": [
{
"destination-port": "integer"
"compact": {
"rs-bs": "integer"
"session": {
"rsvp-session": {
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
}
"ps-bs": "integer"
"requests": "integer"
"detail-list-size": "integer"
}
"protocol": "integer"
"extended-tunnel-id": "string"
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { Interface flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { Interface flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { Interface flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-valid": "boolean", Is the label information valid
"p2mp-sub-group-origin": "string" Point to Multipoint SubGroup Origin
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer", Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
"lsp-wrap-label": "string"
"is-rro-valid": "boolean"
"sub-group-id": "integer"
"protection": {
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
"destination-address": "string"
"tunnel-name": "string"
"in-label": "string"
"association": {
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
"extended-ipv6": {
"extended-id": [
{
"entry": "integer"
}
]
"source": "string"
"global-source": "integer"
"type": "integer"
"id": "integer"
}
"ipv4": {
"source": "string"
"type": "integer"
"id": "integer"
}
"association-type": "string"
"ipv6": {
"source": "string"
"type": "integer"
"id": "integer"
}
}
"in-interface": "string"
"generic-in-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
"g709otn-tspec": {
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{,
"entry": "integer"
}
]
}
]
}
"is-bad-address": "boolean"
"is-traffic-spec-valid": "boolean"
"incoming-interface-address": "string"
"is-ero-valid": "boolean"
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
"ipv4ero-sub-object": {
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
"ero-type": "string"
}
]
"lsp-id": "integer"
}
]
"rsb-info": [
{
"generic-out-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"out-interface": "string"
"is-valid": "boolean"
"backup-interface": "string"
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
}
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean"
"flags": {
"is-global-label": "boolean" Label is Global across all interfaces
}
"label": "integer"
}
"rro-type": "string"
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
"rro-address": "string"
}
"unnumbered-rro-sub-object": {
"interface-id": "integer"
"flags": {
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
"interface-address": "string"
}
}
]
"is-rro-valid": "boolean"
"destination-address": "string"
"backup-label": "string"
"out-label": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"is-flow-spec-valid": "boolean"
}
]
}
]
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
"session-briefs": {
"session-brief": [
{
"destination-port": "integer"
"protocol": "integer"
"extended-tunnel-id": "string"
"rs-bs": "integer"
"vrf-name": "string"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"session-type": "string"
"detail-list-size": "integer"
"requests": "integer"
"ps-bs": "integer"
"p2mp-id": "integer"
}
]
}
"interface-summaries": {
"interface-summary": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"interface-name": "string"
"reservations-out": "integer"
"paths-in": "integer"
"interface-name-xr": "string"
"reservations-in": "integer"
"paths-out": "integer"
}
]
}
"authentication-briefs": {
"authentication-brief": [
{
"neighbor-address": "string"
"direction": "string"
"key-source": "string"
"interface-name": "string"
"source-address": "string"
"key-type": "string"
"key-id-valid": "integer"
"destination-address-xr": "string"
"source-address-xr": "string"
"destination-address": "string"
"mode-id": "string"
"key-id": "integer"
}
]
}
"frr-summary": {
"reservation-states": {
"active-instances": "integer"
"active-wait-instances": "integer"
"total": "integer"
"ready-instances": "integer"
}
"path-states": {
"active-instances": "integer"
"active-wait-instances": "integer"
"total": "integer"
"ready-instances": "integer"
}
}
"frrs": {
"frr": [
{
"destination-port": "integer"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"sub-group-origin": "string"
"path-status": "string"
"sub-group-id": "integer"
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
"reservation-status": "string"
"source-port": "integer"
}
]
}
"psb-detaileds": {
"psb-detailed": [
{
"input-interface": "string"
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string"
"ero-interface-id": "integer"
"is-strict-route": "boolean"
"ero-router-id": "string"
}
"ipv4ero-sub-object": {
"prefix-length": "integer"
"ero-address": "string"
"is-strict-route": "boolean"
}
"ero-type": "string"
}
]
"is-out-ero-valid": "boolean"
"header": {
"rsvp-version": "integer"
"ip-ttl": "integer"
"ip-tos": "integer"
"rsvp-header-flags": "integer"
"ip-source-address": "string"
"rsvp-message-type": "integer"
"rsvp-ttl": "integer"
}
"session-attribute": {
"reservation-priority": "integer"
"setup-priority": "integer"
"sess-attribute-flags": {
"is-local-protect": "boolean"
"is-node-protect": "boolean"
"is-bandwidth-protect": "boolean"
"is-shared-explicit-requested": "boolean"
"is-record-labels": "boolean"
}
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"policy-source-info": {
"is-local": "boolean"
"is-cops": "boolean"
"is-cable": "boolean"
"is-default": "boolean"
"is-te-link": "boolean"
}
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string"
"ero-interface-id": "integer"
"is-strict-route": "boolean"
"ero-router-id": "string"
}
"ipv4ero-sub-object": {
"prefix-length": "integer"
"ero-address": "string"
"is-strict-route": "boolean"
}
"ero-type": "string"
}
]
"backup-tunnel-name": "string"
"extended-tunnel-id": "string"
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"hop": {
"neighbor-address": "string"
"neighbor-logical-interface-name": "string"
}
"p2mp-id": "integer"
"destination-port": "integer"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"pfc": [
{
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"output-interface": "string"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
}
]
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"path-flags": {
"is-bidirectional": "boolean"
"is-lockout": "boolean"
"is-non-rsvp-hop-upstream": "boolean"
"is-message-id-valid": "boolean"
"is-local-sender": "boolean"
"is-local-repair": "boolean"
}
"sub-group-id": "integer"
"label-info": {
"is-valid": "boolean"
"lsp-wrap-label": "string"
"local-downstream-label": "string"
"generic-local-downstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"generic-recovery-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"outgoing-downstream-label": "string"
"local-upstream-label": "string"
"generic-merge-point-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"recovery-label": "string"
"outgoing-upstream-label": "string"
"generic-outgoing-downstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"generic-local-upstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"merge-point-label": "string"
"generic-outgoing-upstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
"destination-address": "string"
"source-port": "integer"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
"is-in-ero-valid": "boolean"
"class-type": {
"is-class-type-info-valid": "boolean"
"class-type": "integer"
}
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
}
]
}
"hello-instance-details": {
"hello-instance-detail": [
{
"hello-interval": "integer"
"source-address": "string"
"communication-lost-wrong-source-inst": "integer"
"destination-address": "string"
"up-time": {
"seconds": "string"
"nanoseconds": "string"
}
"communication-lost-reason": "string"
"destination-address-xr": "string"
"hello-interface": "string"
"source-address-xr": "string"
"destination-instance": "integer"
"instance-type": "string"
"source-instance": "integer"
"communication-lost-time": {
"seconds": "string"
"nanoseconds": "string"
}
"hello-request-suppressed": "integer"
"communication-lost-hello-missed": "integer"
"hello-messages-received": "integer"
"missed-acks-allowed": "integer"
"communication-lost-neighbor-disabled-hello": "integer"
"total-communication-lost": "integer"
"communication-lost-interface-down": "integer"
"hello-instance-owner": "string"
"neighbor-hello-state": "string"
"communication-lost-wrong-destination-inst": "integer"
"hello-messages-sent": "integer"
}
]
}
"controller-detaileds": {
"controller-detailed": [
{
"ack-max-size": "integer"
"controller-name": "string"
"expiry-timer-state": "string"
"summary-refresh-max-size": "integer"
"integrity-send-password": "string"
"expiry-interval": "string"
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"pacing-timer-state": "string"
"interface-name-xr": "string"
"integrity-receive-password-optional": "integer"
"pacing-message-rate": "integer"
"bundle-message-max-size": "integer"
"out-of-band-refresh-interval": "integer"
"ack-hold-time": "integer"
"refresh-timer-state": "string"
"summary-refresh-timer-state": "string"
"refresh-interval": "string"
"pacing-messages": "string"
"flags": {
"is-rel-s-refresh-enabled": "boolean"
"is-interface-down": "boolean"
"is-backup-tunnel": "boolean"
"is-mpls-enabled": "boolean"
"is-s-refresh-enabled": "boolean"
"is-refresh-enabled": "boolean"
"is-pacing-enabled": "boolean"
"is-non-default-vrf": "boolean"
"is-refresh-reduction-enabled": "boolean"
"is-message-bundling-enabled": "boolean"
"is-interface-created": "boolean"
"is-rsvp-configured": "boolean"
}
"pacing-interval": "integer"
"integrity-receive-password": "string"
"expiry-drops-tolerated": "string"
"signalling-ip-tos": "integer"
"expiry-states": "string"
"retransmit-time": "integer"
"neighbor-array": [
{
"neighbor-address": "string"
"outgoing-states": "string"
"neighbor-message-id": [
{
"message-id": "string"
}
]
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"message-ids": "integer"
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
"out-of-band-expiry-drops-tolerated": "integer"
}
]
}
"interface-detaileds": {
"interface-detailed": [
{
"ack-max-size": "integer"
"expiry-timer-state": "string"
"summary-refresh-max-size": "integer"
"integrity-send-password": "string"
"expiry-interval": "string"
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"pacing-timer-state": "string"
"interface-name-xr": "string"
"integrity-receive-password-optional": "integer"
"pacing-message-rate": "integer"
"bundle-message-max-size": "integer"
"out-of-band-refresh-interval": "integer"
"ack-hold-time": "integer"
"interface-name": "string"
"refresh-timer-state": "string"
"summary-refresh-timer-state": "string"
"refresh-interval": "string"
"pacing-messages": "string"
"flags": {
"is-rel-s-refresh-enabled": "boolean"
"is-interface-down": "boolean"
"is-backup-tunnel": "boolean"
"is-mpls-enabled": "boolean"
"is-s-refresh-enabled": "boolean"
"is-refresh-enabled": "boolean"
"is-pacing-enabled": "boolean"
"is-non-default-vrf": "boolean"
"is-refresh-reduction-enabled": "boolean"
"is-message-bundling-enabled": "boolean"
"is-interface-created": "boolean"
"is-rsvp-configured": "boolean"
}
"pacing-interval": "integer"
"integrity-receive-password": "string"
"expiry-drops-tolerated": "string"
"signalling-ip-tos": "integer"
"expiry-states": "string"
"retransmit-time": "integer"
"neighbor-array": [
{
"neighbor-address": "string"
"outgoing-states": "string"
"neighbor-message-id": [
{
"message-id": "string"
}
]
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"message-ids": "integer"
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
"out-of-band-expiry-drops-tolerated": "integer"
}
]
}
"psb-briefs": {
"psb-brief": [
{
"destination-port": "integer"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"session-attribute": {
"reservation-priority": "integer"
"setup-priority": "integer"
"sess-attribute-flags": {
"is-local-protect": "boolean"
"is-node-protect": "boolean"
"is-bandwidth-protect": "boolean"
"is-shared-explicit-requested": "boolean"
"is-record-labels": "boolean"
}
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"source-port": "integer"
"extended-tunnel-id": "string"
"input-interface": "string"
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"p2mp-id": "integer"
}
]
}
"summary": {
"ls-ps": "integer"
"interfaces": "integer"
"issu-status": {
"role": "string"
"idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
"previous-idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
}
"database-counters": {
"incoming-paths": "integer"
"sessions": "integer"
"interfaces": "integer"
"outgoing-paths": "integer"
"outgoing-reservations": "integer"
"incoming-reservations": "integer"
}
"nsr-status": {
"role": "string"
"idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
"previous-idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
}
}
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"restart-state": "string"
"neighbor-address": "string"
"global-neighbor-flags": {
"is-application-mpls": "boolean"
"is-application-ouni": "boolean"
}
"lost-communication-reason": [
{
"entry": "string"
}
]
"lost-communication-total": [
{
"entry": "integer"
}
]
"lost-communication-time": [
{
"seconds": "string"
"nanoseconds": "string"
}
]
"is-gr-enabled": "boolean"
"local-node-address": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string"
"nanoseconds": "string"
}
]
"node-address": "string"
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
"hello-interface-instance-briefs": {
"hello-interface-instance-brief": [
{
"destination-address-xr": "string"
"hello-interface": "string"
"source-address": "string"
"destination-address": "string"
"instance-type": "string"
"source-address-xr": "string"
}
]
}
"request-details": {
"request-detail": [
{
"destination-port": "integer"
"protocol": "integer"
"policy-sources": {
"is-local": "boolean"
"is-cops": "boolean"
"is-cable": "boolean"
"is-default": "boolean"
"is-te-link": "boolean"
}
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"rsb-key": [
{
"vrfid": "string"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"destination-port-or-tunnel-id": "integer"
"sub-group-id": "integer"
"destination-address": "string"
"session-type": "string"
"p2mp-sub-group-origin": "string"
"p2mp-id": "integer"
"source-port-or-lsp-id": "integer"
}
]
"header": {
"rsvp-version": "integer"
"ip-ttl": "integer"
"ip-tos": "integer"
"rsvp-header-flags": "integer"
"ip-source-address": "string"
"rsvp-message-type": "integer"
"rsvp-ttl": "integer"
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"source-port": "integer"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"style": {
"reservation-type": "string"
}
"extended-tunnel-id": "string"
"psb-key": [
{
"vrfid": "string"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"destination-port-or-tunnel-id": "integer"
"sub-group-id": "integer"
"destination-address": "string"
"session-type": "string"
"p2mp-sub-group-origin": "string"
"p2mp-id": "integer"
"source-port-or-lsp-id": "integer"
}
]
"output-interface": "string"
"req-flags": {
"is-rro-in-path": "boolean"
"is-send-confirm": "boolean"
"is-merge-point": "boolean"
"is-refreshing": "boolean"
"is-ack-outstanding": "boolean"
"is-retransmit": "boolean"
"is-label-request-in-path": "boolean"
"is-nack-received": "boolean"
"is-record-label-in-path": "boolean"
"is-message-id-allocated": "boolean"
"is-paced": "boolean"
"is-local-receiver": "boolean"
}
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"hop": {
"neighbor-address": "string"
"neighbor-logical-interface-name": "string"
}
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"p2mp-id": "integer"
}
]
}
"interface-neighbor-briefs": {
"interface-neighbor-brief": [
{
"neighbor-address": "string"
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string"
"interface-neighbor-address": "string"
}
]
"node-address": "string"
}
]
}
"authentication-details": {
"authentication-detail": [
{
"lifetime-left": "integer"
"interface-name": "string"
"source-address": "string"
"key-digest-info": "integer"
"key-status": "integer"
"challenge-status": "string"
"destination-address": "string"
"direction-info": {
"receive-info": {
"sequence-window-size": "integer"
"sequence": "integer"
"sequence-window-count": "integer"
"sequence-window": [
{
"entry": "integer"
}
]
"counters": {
"authentication-received-no-integrity": "integer"
"authentication-received-incomplete": "integer"
"authentication-received-valid-messages": "integer"
"authentication-received-sequence-number-duplicate": "integer"
"authentication-received-sequence-number-outof-range": "integer"
"authentication-received-challenge-timeouts": "integer"
"authentication-received-challenges-response-duplicate": "integer"
"authentication-received-challenges-resent": "integer"
"authentication-received-challenge-response": "integer"
"authentication-received-response-late": "integer"
"authentication-received-challenges-sent": "integer"
"authentication-received-bad-digest": "integer"
"authentication-received-during-challenge": "integer"
"authentication-received-wrong-challenges-response": "integer"
"authentication-received-bad-message-format": "integer"
"authentication-received-wrong-digest-type": "integer"
}
}
"send-info": {
"sequence": "integer"
"counters": {
"authentication-challenge-responses-sent": "integer"
"authentication-sent": "integer"
"authentication-send-challenges-received": "integer"
"authentication-failures": "integer"
}
}
"auth-direction": "string"
}
"lifetime": "integer"
"mode-id": "string"
"auth-compact": {
"neighbor-address": "string"
"direction": "string"
"key-source": "string"
"key-type": "string"
"key-id-valid": "integer"
"destination-address-xr": "string"
"source-address-xr": "string"
"key-id": "integer"
}
}
]
}
"graceful-restart": {
"missed-hellos": "integer"
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"hello-interval": "integer"
"global-neighbors": "integer"
"is-gr-enabled": "boolean"
"local-node-address": [
{
"local-node-ip-address": "string"
"application-type": "string"
}
]
"recovery-time": "integer"
"recovery-timer-exp-time": {
"seconds": "string"
"nanoseconds": "string"
}
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
}
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-briefs": { Table of brief info about I/F neighbors
{
"neighbor-address": "string", Address of global neighbor
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summaries": { Table of summary info about RSVP-enabled\ncontrollers
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-briefs": { Table for Authentication related information
"authentication-brief": [
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-briefs": { Table of brief info about sessions
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"vrf-name": "string", VRF Name
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detaileds": { Table of detailed info about path state blocks
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean" Outgoing ERO validity
"header": { RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer", RSVP TTL
},
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"policy-source-info": { Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string" Extended Tunnel ID
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string", Time Value in Nano-seconds
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"destination-port": "integer", Destination Port
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"pfc": [
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"output-interface": "string", Output interface
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
]
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string", Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"path-flags": { Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Subgroup ID
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"destination-address": "string", Destination Address
"source-port": "integer", Source Port
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"is-in-ero-valid": "boolean", Incoming ERO validity
"class-type": { DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
]
}
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-flags": { Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-source-info": { Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"class-type": { DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
}
}
PFC - Retrieve
Retrieve operation of resource: pfc
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detaileds": { Table of detailed info about RSVP-enabled\ncontrollers
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
{
"message-id": "string" Message ID
}
]
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"message-ids": "integer", Number of MessageIDs
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer" Number of out-of-band missed messages tolerated
}
]
}
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr-summary": { Fast Re-Route Summary State Information
"reservation-states": { Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": { Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-states": { Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": { Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detaileds": { Table of detailed info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"input-adjusted-interface": "string", Input Adjusted Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"input-physical-interface": "string", Input Physical Interface
"p2mp-id": "integer", P2MP ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
]
}
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summaries": { Table of summary info about RSVP-enabled\ninterfaces
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-briefs": { Table of brief info about hello instances
"hello-instance-brief": [
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-details": { Table for detailed authentication related\ninformation
"authentication-detail": [
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": { direction info
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
},
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": { Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auth-compact": { Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"direction-info": { direction info
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
},
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
},
"auth-direction": "string" AuthDirection
}
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-briefs": { Table of brief info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Info
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Info
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
OPEN-CONFIG - Retrieve
Retrieve operation of resource: open-config
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"open-config": { OpenConfig info
"global-counters": { Platform wide RSVP statistics and counters
"out-hello-messages": "integer", Per interface count of hello messages send
"rate-limited-messages": "integer", Global count of rate limited messages
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"in-ack-messages": "integer", Per interface count of ack messages received
"path-timeouts": "integer", Global count of Path Timeouts
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"in-hello-messages": "integer", Per interface count of hello messages received
"reservation-timeouts": "integer", Global count of reservation timeouts
"out-ack-messages": "integer", Per interface count of ack messages send
"in-path-error-messages": "integer", Per interface count of path error messages\nreceived
"out-reservation-error-messages": "integer" Per interface count of reservation error\nmessages send
},
"interface-counters": { Table of info about RSVP-enabled interface\ncounters for OpenConfig
{
"out-ack-messages": "integer", Per interface count of ack messages send
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"interface-name-xr": "string", Interface name
"in-hello-messages": "integer", Per interface count of hello messages received
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-reservation-error-messages": "integer", Per interface count of reservation error\nmessages send
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"interface-name": "string", Interface name
"in-ack-messages": "integer", Per interface count of ack messages received
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"out-hello-messages": "integer", Per interface count of hello messages send
"in-path-error-messages": "integer" Per interface count of path error messages\nreceived
}
]
}
}
}
GLOBAL-COUNTERS - Retrieve
Retrieve operation of resource: global-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-counters": { Platform wide RSVP statistics and counters
"out-hello-messages": "integer", Global count of hello messages send
"rate-limited-messages": "integer", Global count of rate limited messages
"in-reservation-messages": "integer", Global count of reservation messages received
"out-reservation-tear-messages": "integer", Global count of reservation tear messages send
"out-path-tear-messages": "integer", Global count of path tear messages send
"in-ack-messages": "integer", Global count of ack messages received
"path-timeouts": "integer", Global count of Path Timeouts
"in-srefresh-messages": "integer", Global count of srefresh messages received
"in-reservation-tear-messages": "integer", Global count of reservation tear messages\nreceived
"out-path-error-messages": "integer", Global count of path error messages send
"out-reservation-messages": "integer", Global count of reservation messages send
"in-reservation-error-messages": "integer", Global count of reservation error messages\nreceived
"in-path-tear-messages": "integer", Global count of path tear messages received
"out-srefresh-messages": "integer", Global count of srefresh messages send
"out-path-messages": "integer", Global count of path messages send
"in-path-messages": "integer", Global count of path messages received
"in-hello-messages": "integer", Global count of hello messages received
"reservation-timeouts": "integer", Global count of reservation timeouts
"out-ack-messages": "integer", Global count of ack messages send
"in-path-error-messages": "integer", Global count of path error messages received
"out-reservation-error-messages": "integer" Global count of reservation error messages send
}
}
INTERFACE-COUNTERS - Retrieve
Retrieve operation of resource: interface-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-counters": { Table of info about RSVP-enabled interface\ncounters for OpenConfig
{
"out-ack-messages": "integer", Per interface count of ack messages send
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"interface-name-xr": "string", Interface name
"in-hello-messages": "integer", Per interface count of hello messages received
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-reservation-error-messages": "integer", Per interface count of reservation error\nmessages send
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"interface-name": "string", Interface name
"in-ack-messages": "integer", Per interface count of ack messages received
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"out-hello-messages": "integer", Per interface count of hello messages send
"in-path-error-messages": "integer" Per interface count of path error messages\nreceived
}
]
}
}
INTERFACE-COUNTER - Retrieve
Retrieve operation of resource: interface-counter
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"interface-messages": { Table of message counters
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": { Summary information for all RSVP message\ncounters
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": { Table containing event sync counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"database": { Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Table of interface specific out of resource\ncounters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": { Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": { Prefix filtering counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": { Event counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"nsr": { Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": { Out of resource counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": { Table of message counters
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-summary": { Summary information for all RSVP message\ncounters
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-filtering": { Prefix filtering counters
"interfaces": { Table of interface specific prefix filtering\ncounters
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
ACCESS - Retrieve
Retrieve operation of resource: access
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific prefix filtering\ncounters
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-of-resource": { Out of resource counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-events": { Event counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": { Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": { Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database": { Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-syncs": { Table containing event sync counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detaileds": { Table of detailed info about RSVP-enabled\ninterfaces
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
{
"message-id": "string" Message ID
}
]
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"message-ids": "integer", Number of MessageIDs
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer" Number of out-of-band missed messages tolerated
}
]
}
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-briefs": { Table of brief info about RSVP-enabled\ncontroller
{
"controller-name": "string", Controller Name
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart": { Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer" Recovery time (milliseconds)
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string", Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-briefs": { Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-details": { Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [
{
"last-message-sent-time": { Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": { Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-details": { Table of detailed info about I/F neighbors
{
"neighbor-address": "string", Address of global neighbor
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": { RSVP NSR information
"status": { RSVP NSR status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": { RSVP NSR status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Number of Interfaces
"issu-status": { Issu status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": { All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": { NSR status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu-status": { Issu status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-status": { NSR status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-counters": { All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
FRRS - Retrieve
Retrieve operation of resource: frrs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frrs": { Table of detailed info about Fast Re-route\nstates
"frr": [
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"sub-group-id": "integer", Subgroup ID
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer", P2MP ID
"reservation-status": "string", RSVP FRR Reservation States
"source-port": "integer" Source Port
}
]
}
}
FRR - Retrieve
Retrieve operation of resource: frr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-briefs": { Table of brief info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-details": { Table of detail info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
]
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer", RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"output-interface": "string" output Interface
"req-flags": { Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean", Local Receiver
},
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"req-flags": { Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-briefs": { Table of brief info about RSVP-enabled\ninterfaces
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detaileds": { Table of detailed info about sessions
{
"destination-port": "integer", The Session Destination Port
"compact": { Compact session data
"rs-bs": "integer", Number of reservation state block states
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { IPV4 ASSOCIATION Object
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer" Number of elements in detail list
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
{
{
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Unnumbered Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string" Point to Multipoint SubGroup Origin
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string" TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer", Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"lsp-wrap-label": "string", LSP Wrap Label
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": { Protection object
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": { Association object
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": { IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": { IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": { Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"reverse-lsp": { Reverse LSP object
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{,
"entry": "integer"
}
]
}
]
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"traffic-spec": { Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"lsp-id": "integer" LSP ID
}
]
"rsb-info": [
{
"generic-out-label": { Generic Label for outbound traffic
"generic-label-type": "string" GenericLabelType
"generalized-label": { Generalized Label
"value": [
{,
"entry": "integer"
}
]
}
},
"flow-spec": { Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"out-interface": "string", Interface on which outbound message was sent
"is-valid": "boolean", Entry validity
"backup-interface": "string", Backup tunnel interface
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Unnumbered Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string" Label for outbound traffic
"generic-flow-spec": { Generic Flow Spec object
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer", G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
]
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
COMPACT - Retrieve
Retrieve operation of resource: compact
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": { Compact session data
"rs-bs": "integer", Number of reservation state block states
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer" Number of elements in detail list
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-in-label": { Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"association": { Association object
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
"ipv4": {
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
"association-type": "string"
"ipv6": {
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6": { IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV4 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protection": { Protection object
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
}
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reverse-lsp": { Reverse LSP object
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{,
"entry": "integer"
}
]
}
]
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": { Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec object
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-details": { Table of detailed info about hello instances
"hello-instance-detail": [
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"up-time": { Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": { Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": { Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-time": { Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-details": { Table of detailed info about global neighbors
{
"restart-state": "string", Current restart state
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"hello-interval": "integer", Hello Interval (milliseconds)
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [
{
"entry": "string"
}
]
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"restart-timer-expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"restart-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"neighbor-address": "string"
"missed-hellos": "integer"
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"recovery-time": "integer"
"node-address": "string"
"is-restart-timer-running": "boolean"
"neighbor-hello-state": [
{
"entry": "string"
}
]
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
]
}
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-time-left": { How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-timer-expiry-time": { When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-briefs": { Table of brief info about path state blocks
{
"destination-port": "integer", The Session Destination Port
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"source-port": "integer", Source Port
"extended-tunnel-id": "string", Extended Tunnel ID
"input-interface": "string", Path Input Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-briefs": { Table of brief info about global neighbors
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean" Is GR enabled
"local-node-address": [
{,
"entry": "string"
}
]
"up-time": [
{,
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string" Neighbor node address
"neighbor-hello-state": [
{,
"entry": "string"
}
]
}
]
}
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSVP - Retrieve
Retrieve operation of resource: rsvp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp": { rsvp
"hello-instance-briefs": { Table of brief info about hello instances
"hello-instance-brief": [
{
"source-address": "string", Source Address
"lost-communication-total": "integer",
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string",
"instance-type": "string" Hello instance type
}
]
},
"request-briefs": { Table of brief info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", output Interface
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
},
"hello-interface-instance-briefs": { Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
},
"interface-neighbor-details": { Table of detailed info about I/F neighbors
{
"neighbor-address": "string", Neighbor address
{
"retransmitted-messages": "integer", Count of messages retransmitted
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Count of Out of Order messages
}
],
"node-address": "string" Neighbor node address
}
]
},
"nsr": { Summary information for all RSVP NSR counters
"status": { RSVP ISSU status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"controller-briefs": { Table of brief info about RSVP-enabled\ncontroller
{
"controller-name": "string", Controller Name
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
},
"rsb-detaileds": { Table of detailed info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"label-info": { Label Information
"is-valid": "boolean", Entry validity
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"input-adjusted-interface": "string", Input Adjusted Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"input-physical-interface": "string", Input Physical Interface
"p2mp-id": "integer", P2MP ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
]
},
"interface-neighbor-briefs": { Table of brief info about I/F neighbors
{
"neighbor-address": "string", Neighbor address
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
},
"rxsb-details": { Table of detailed RXSB info
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": { RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
},
"global-neighbor-details": { Table of detailed info about global neighbors
{
"restart-state": "string", Restart state
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"hello-interval": "integer", Interval at which hello messages are sent
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [
{
"entry": "string"
}
]
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"restart-timer-expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"restart-time-left": {
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
"neighbor-address": "string"
"missed-hellos": "integer"
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"recovery-time": "integer"
"node-address": "string"
"is-restart-timer-running": "boolean"
"neighbor-hello-state": [
{
"entry": "string"
}
]
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
]
}
"open-config": {
"global-counters": {
"out-hello-messages": "integer"
"rate-limited-messages": "integer"
"in-reservation-messages": "integer"
"out-reservation-tear-messages": "integer"
"out-path-tear-messages": "integer"
"in-ack-messages": "integer"
"path-timeouts": "integer"
"in-srefresh-messages": "integer"
"in-reservation-tear-messages": "integer"
"out-path-error-messages": "integer"
"out-reservation-messages": "integer"
"in-reservation-error-messages": "integer"
"in-path-tear-messages": "integer"
"out-srefresh-messages": "integer"
"out-path-messages": "integer"
"in-path-messages": "integer"
"in-hello-messages": "integer"
"reservation-timeouts": "integer"
"out-ack-messages": "integer"
"in-path-error-messages": "integer"
"out-reservation-error-messages": "integer"
}
"interface-counters": {
"interface-counter": [
{
"out-ack-messages": "integer"
"in-reservation-messages": "integer"
"in-srefresh-messages": "integer"
"in-path-tear-messages": "integer"
"interface-name-xr": "string"
"in-hello-messages": "integer"
"out-reservation-tear-messages": "integer"
"out-reservation-error-messages": "integer"
"in-reservation-tear-messages": "integer"
"out-path-tear-messages": "integer"
"interface-name": "string"
"in-ack-messages": "integer"
"out-path-error-messages": "integer"
"out-reservation-messages": "integer"
"in-reservation-error-messages": "integer"
"out-srefresh-messages": "integer"
"out-path-messages": "integer"
"in-path-messages": "integer"
"out-hello-messages": "integer"
"in-path-error-messages": "integer"
}
]
}
}
"rsb-briefs": {
"rsb-brief": [
{
"destination-port": "integer"
"input-interface": "string"
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
"ipv4-uni-session": {
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
}
"session-type": "string"
"ipv4": {
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination Address
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
}
"destination-address": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"source-port": "integer"
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"style": {
"reservation-type": "string"
}
"extended-tunnel-id": "string"
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
"p2mp-ipv4-session": {
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
"filter-type": "string"
}
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
"counters": {
"interface-messages": {
"interface-message": [
{
"transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"retransmitted-messages": "integer"
"interface-name": "string"
"rate-limited-messages": "integer"
"received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"out-of-order-messages": "integer"
}
]
}
"message-summary": {
"transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"retransmitted-messages": "integer"
"rate-limited-messages": "integer"
"received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-received-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"bundle-transmitted-messages": {
"ack": "integer"
"challenge": "integer"
"reservation-confirm": "integer"
"bundle": "integer"
"response": "integer"
"srefresh": "integer"
"path-error": "integer"
"reservation-error": "integer"
"reservation": "integer"
"path": "integer"
"path-tear": "integer"
"hello": "integer"
"reservation-tear": "integer"
}
"out-of-order-messages": "integer"
}
"event-syncs": {
"event-sync": [
{
"nac-ks": "integer"
"expired-paths": "integer"
"expired-reservations": "integer"
"interface-name": "string"
}
]
}
"database": {
"incoming-paths": "integer"
"sessions": "integer"
"interfaces": "integer"
"outgoing-paths": "integer"
"outgoing-reservations": "integer"
"incoming-reservations": "integer"
}
"issu": {
"total-id-ts": "integer"
"last-cleared-timestamp": "integer"
"total-states": "integer"
"last-idt-states": "integer"
"total-deletions": "integer"
"rsvp-process-role": "string"
"total-nacks": "integer"
}
"prefix-filtering": {
"interfaces": {
"interfaces": {
"interface": [
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total number of instances of this state
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", InterfaceName
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
"summary": {
"default-action-dropped": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"forwarded": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"default-action-processed": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"locally-destined": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"dropped": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
"total": {
"total": "integer"
"path": "integer"
"reservation-confirm": "integer"
"path-tear": "integer"
}
}
}
"accesses": {
"access": [
{
"access-list-name": "string"
"forwarded": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"total": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"dropped": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
"locally-destined": {
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
"interface-events": {
"interface-event": [
{
"nac-ks": "integer"
"expired-paths": "integer"
"expired-reservations": "integer"
"interface-name": "string"
}
]
}
"nsr": {
"total-id-ts": "integer"
"last-cleared-timestamp": "integer"
"total-states": "integer"
"last-idt-states": "integer"
"total-deletions": "integer"
"rsvp-process-role": "string"
"total-nacks": "integer"
}
"out-of-resource": {
"interfaces": {
"interfaces": {
"interface": [
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" InterfaceName
}
]
}
"summary": {
"dropped-path-messages": "integer"
}
}
}
}
"controller-summaries": {
"controller-summary": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"reservations-out": "integer"
"interface-name-xr": "string"
"paths-in": "integer"
"controller-name": "string"
"reservations-in": "integer"
"paths-out": "integer"
}
]
}
"interface-briefs": {
"interface-brief": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"interface-name": "string"
"interface-name-xr": "string"
}
]
}
"psb-detaileds": {
"psb-detailed": [
{
"input-interface": "string"
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string", RSVP ISSU status information
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
"ipv4ero-sub-object": {
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
"ero-type": "string"
}
]
"is-out-ero-valid": "boolean"
"header": {
"rsvp-version": "integer"
"ip-ttl": "integer"
"ip-tos": "integer"
"rsvp-header-flags": "integer"
"ip-source-address": "string"
"rsvp-message-type": "integer"
"rsvp-ttl": "integer"
}
"session-attribute": {
"reservation-priority": "integer"
"setup-priority": "integer"
"sess-attribute-flags": {
"is-local-protect": "boolean"
"is-node-protect": "boolean"
"is-bandwidth-protect": "boolean"
"is-shared-explicit-requested": "boolean"
"is-record-labels": "boolean"
}
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"policy-source-info": {
"is-local": "boolean"
"is-cops": "boolean"
"is-cable": "boolean"
"is-default": "boolean"
"is-te-link": "boolean"
}
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string"
"ero-interface-id": "integer"
"is-strict-route": "boolean"
"ero-router-id": "string"
}
"ipv4ero-sub-object": {
"prefix-length": "integer"
"ero-address": "string"
"is-strict-route": "boolean"
}
"ero-type": "string"
}
]
"backup-tunnel-name": "string"
"extended-tunnel-id": "string"
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"hop": {
"neighbor-address": "string"
"neighbor-logical-interface-name": "string"
}
"p2mp-id": "integer"
"destination-port": "integer"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"pfc": [
{
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"output-interface": "string"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
}
]
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"path-flags": {
"is-bidirectional": "boolean"
"is-lockout": "boolean"
"is-non-rsvp-hop-upstream": "boolean"
"is-message-id-valid": "boolean"
"is-local-sender": "boolean"
"is-local-repair": "boolean"
}
"sub-group-id": "integer"
"label-info": {
"is-valid": "boolean"
"lsp-wrap-label": "string"
"local-downstream-label": "string"
"generic-local-downstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"generic-recovery-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"outgoing-downstream-label": "string"
"local-upstream-label": "string"
"generic-merge-point-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"recovery-label": "string"
"outgoing-upstream-label": "string"
"generic-outgoing-downstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"generic-local-upstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"merge-point-label": "string"
"generic-outgoing-upstream-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
"destination-address": "string"
"source-port": "integer"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
"is-in-ero-valid": "boolean"
"class-type": {
"is-class-type-info-valid": "boolean"
"class-type": "integer"
}
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
}
]
}
"session-detaileds": {
"session-detailed": [
{
"destination-port": "integer"
"compact": {
"rs-bs": "integer"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"ps-bs": "integer"
"requests": "integer"
"detail-list-size": "integer"
}
"protocol": "integer"
"extended-tunnel-id": "string"
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { Interface flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
}
"rro-type": "string"
"ipv4rro-sub-object": {
"flags": { Interface flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
"unnumbered-rro-sub-object": {
"interface-id": "integer", The RRO Interface ID
"flags": { Interface flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
]
"is-valid": "boolean"
"p2mp-sub-group-origin": "string"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"lsp-wrap-label": "string"
"is-rro-valid": "boolean"
"sub-group-id": "integer"
"protection": {
"link-flags": {
"reserved-bit2": "boolean"
"reserved-bit1": "boolean"
"unprotected": "boolean"
"ded1-plus1": "boolean"
"enhanced": "boolean"
"shared": "boolean"
"extra-traffic": "boolean"
"ded1-to1": "boolean"
}
"s": "boolean"
"o": "boolean"
"n": "boolean"
"p": "boolean"
"lsp-flags": {
"rerouting-no-et": "boolean"
"one-plus-one-uni": "boolean"
"one-plus-one-bi": "boolean"
"rerouting": "boolean"
"one-to-n-protection-et": "boolean"
}
}
"destination-address": "string"
"tunnel-name": "string"
"in-label": "string"
"association": {
"extended-ipv4": {
"extended-id": [
{
"entry": "integer"
}
]
"source": "string"
"global-source": "integer"
"type": "integer"
"id": "integer"
}
"extended-ipv6": {
"extended-id": [
{
"entry": "integer"
}
]
"source": "string"
"global-source": "integer"
"type": "integer"
"id": "integer"
}
"ipv4": {
"source": "string"
"type": "integer"
"id": "integer"
}
"association-type": "string"
"ipv6": {
"source": "string"
"type": "integer"
"id": "integer"
}
}
"in-interface": "string"
"generic-in-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string"
"ero-interface-id": "integer"
"is-strict-route": "boolean"
"ero-router-id": "string"
}
"ipv4ero-sub-object": {
"prefix-length": "integer"
"ero-address": "string"
"is-strict-route": "boolean"
}
"ero-type": "string"
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
]
}
"is-bad-address": "boolean"
"is-traffic-spec-valid": "boolean"
"incoming-interface-address": "string"
"is-ero-valid": "boolean"
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string"
"ero-interface-id": "integer"
"is-strict-route": "boolean"
"ero-router-id": "string"
}
"ipv4ero-sub-object": {
"prefix-length": "integer"
"ero-address": "string"
"is-strict-route": "boolean"
}
"ero-type": "string"
}
]
"lsp-id": "integer"
}
]
"rsb-info": [
{
"generic-out-label": {
"generic-label-type": "string"
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"out-interface": "string"
"is-valid": "boolean"
"backup-interface": "string"
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
}
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean"
"flags": {
"is-global-label": "boolean"
}
"label": "integer"
}
"rro-type": "string"
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean"
"is-protection-in-use": "boolean"
"is-node-id": "boolean"
"is-protection-available": "boolean"
"is-bandwidth-protected": "boolean"
}
"rro-address": "string"
}
"unnumbered-rro-sub-object": {
"interface-id": "integer"
"flags": {
"is-node-protection-available": "boolean"
"is-protection-in-use": "boolean"
"is-node-id": "boolean"
"is-protection-available": "boolean"
"is-bandwidth-protected": "boolean"
}
"interface-address": "string"
}
}
]
"is-rro-valid": "boolean"
"destination-address": "string"
"backup-label": "string"
"out-label": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"is-flow-spec-valid": "boolean"
}
]
}
]
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
"hello-interface-instance-details": {
"hello-interface-instance-detail": [
{
"last-message-sent-time": {
"seconds": "string"
"nanoseconds": "string"
}
"source-address": "string"
"hello-messages-received": "integer"
"hello-global-neighbor-id": "string"
"destination-address-xr": "string"
"hello-interface": "string"
"source-address-xr": "string"
"destination-instance": "integer"
"destination-address": "string"
"instance-type": "string"
"source-instance": "integer"
"hello-messages-sent": "integer"
}
]
}
"session-briefs": {
"session-brief": [
{
"destination-port": "integer"
"protocol": "integer"
"extended-tunnel-id": "string"
"rs-bs": "integer"
"vrf-name": "string"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"session-type": "string"
"detail-list-size": "integer"
"requests": "integer"
"ps-bs": "integer"
"p2mp-id": "integer"
}
]
}
"interface-summaries": {
"interface-summary": [
{
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"interface-name": "string"
"reservations-out": "integer"
"paths-in": "integer"
"interface-name-xr": "string"
"reservations-in": "integer"
"paths-out": "integer"
}
]
}
"authentication-briefs": {
"authentication-brief": [
{
"neighbor-address": "string"
"direction": "string"
"key-source": "string"
"interface-name": "string"
"source-address": "string"
"key-type": "string"
"key-id-valid": "integer"
"destination-address-xr": "string"
"source-address-xr": "string"
"destination-address": "string"
"mode-id": "string"
"key-id": "integer"
}
]
}
"frr-summary": {
"reservation-states": {
"active-instances": "integer"
"active-wait-instances": "integer"
"total": "integer"
"ready-instances": "integer"
}
"path-states": {
"active-instances": "integer"
"active-wait-instances": "integer"
"total": "integer"
"ready-instances": "integer"
}
}
"frrs": {
"frr": [
{
"destination-port": "integer"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"sub-group-origin": "string"
"path-status": "string"
"sub-group-id": "integer"
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
"reservation-status": "string"
"source-port": "integer"
}
]
}
"pxsb-details": {
"pxsb-detail": [
{
"destination-port": "integer"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"protocol": "integer"
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"source-address": "string"
"sub-group-origin": "string"
"dynamic-state": "integer"
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"sub-group-id": "integer"
"source-port": "integer"
"extended-tunnel-id": "string"
"input-interface": "string"
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"hop": {
"neighbor-address": "string"
"neighbor-logical-interface-name": "string"
}
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"p2mp-id": "integer"
"rsvp-header": {
"rsvp-version": "integer"
"ip-ttl": "integer"
"ip-tos": "integer"
"rsvp-header-flags": "integer"
"ip-source-address": "string"
"rsvp-message-type": "integer"
"rsvp-ttl": "integer"
}
}
]
}
"hello-instance-details": {
"hello-instance-detail": [
{
"hello-interval": "integer"
"source-address": "string"
"communication-lost-wrong-source-inst": "integer"
"destination-address": "string"
"up-time": {
"seconds": "string"
"nanoseconds": "string"
}
"communication-lost-reason": "string"
"destination-address-xr": "string"
"hello-interface": "string"
"source-address-xr": "string"
"destination-instance": "integer"
"instance-type": "string"
"source-instance": "integer"
"communication-lost-time": {
"seconds": "string"
"nanoseconds": "string"
}
"hello-request-suppressed": "integer"
"communication-lost-hello-missed": "integer"
"hello-messages-received": "integer"
"missed-acks-allowed": "integer"
"communication-lost-neighbor-disabled-hello": "integer"
"total-communication-lost": "integer"
"communication-lost-interface-down": "integer"
"hello-instance-owner": "string"
"neighbor-hello-state": "string"
"communication-lost-wrong-destination-inst": "integer"
"hello-messages-sent": "integer"
}
]
}
"controller-detaileds": {
"controller-detailed": [
{
"ack-max-size": "integer"
"controller-name": "string"
"expiry-timer-state": "string"
"summary-refresh-max-size": "integer"
"integrity-send-password": "string"
"expiry-interval": "string"
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"pacing-timer-state": "string"
"interface-name-xr": "string"
"integrity-receive-password-optional": "integer"
"pacing-message-rate": "integer"
"bundle-message-max-size": "integer"
"out-of-band-refresh-interval": "integer"
"ack-hold-time": "integer"
"refresh-timer-state": "string"
"summary-refresh-timer-state": "string"
"refresh-interval": "string"
"pacing-messages": "string"
"flags": {
"is-rel-s-refresh-enabled": "boolean"
"is-interface-down": "boolean"
"is-backup-tunnel": "boolean"
"is-mpls-enabled": "boolean"
"is-s-refresh-enabled": "boolean"
"is-refresh-enabled": "boolean"
"is-pacing-enabled": "boolean"
"is-non-default-vrf": "boolean"
"is-refresh-reduction-enabled": "boolean"
"is-message-bundling-enabled": "boolean"
"is-interface-created": "boolean"
"is-rsvp-configured": "boolean"
}
"pacing-interval": "integer"
"integrity-receive-password": "string"
"expiry-drops-tolerated": "string"
"signalling-ip-tos": "integer"
"expiry-states": "string"
"retransmit-time": "integer"
"neighbor-array": [
{
"neighbor-address": "string"
"outgoing-states": "string"
"neighbor-message-id": [
{
"message-id": "string"
}
]
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"message-ids": "integer"
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
"out-of-band-expiry-drops-tolerated": "integer"
}
]
}
"interface-detaileds": {
"interface-detailed": [
{
"ack-max-size": "integer"
"expiry-timer-state": "string"
"summary-refresh-max-size": "integer"
"integrity-send-password": "string"
"expiry-interval": "string"
"bandwidth-information": {
"dste-mode": "string"
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"max-pool1-bandwidth": "integer"
"allocated-bit-rate": "integer"
"max-pool0-bandwidth": "integer"
"max-flow-bandwidth": "integer"
"is-max-bc1-bandwidth-absolute": "boolean"
"is-max-bc0-bandwidth-absolute": "boolean"
"max-bandwidth": "integer"
}
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean"
"is-max-subpool-bandwidth-absolute": "boolean"
"allocated-bit-rate": "integer"
"max-flow-bandwidth": "integer"
"max-subpool-bandwidth": "integer"
"max-bandwidth": "integer"
}
}
"pacing-timer-state": "string"
"interface-name-xr": "string"
"integrity-receive-password-optional": "integer"
"pacing-message-rate": "integer"
"bundle-message-max-size": "integer"
"out-of-band-refresh-interval": "integer"
"ack-hold-time": "integer"
"interface-name": "string"
"refresh-timer-state": "string"
"summary-refresh-timer-state": "string"
"refresh-interval": "string"
"pacing-messages": "string"
"flags": {
"is-rel-s-refresh-enabled": "boolean"
"is-interface-down": "boolean"
"is-backup-tunnel": "boolean"
"is-mpls-enabled": "boolean"
"is-s-refresh-enabled": "boolean"
"is-refresh-enabled": "boolean"
"is-pacing-enabled": "boolean"
"is-non-default-vrf": "boolean"
"is-refresh-reduction-enabled": "boolean"
"is-message-bundling-enabled": "boolean"
"is-interface-created": "boolean"
"is-rsvp-configured": "boolean"
}
"pacing-interval": "integer"
"integrity-receive-password": "string"
"expiry-drops-tolerated": "string"
"signalling-ip-tos": "integer"
"expiry-states": "string"
"retransmit-time": "integer"
"neighbor-array": [
{
"neighbor-address": "string"
"outgoing-states": "string"
"neighbor-message-id": [
{
"message-id": "string"
}
]
"expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"message-ids": "integer"
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
"out-of-band-expiry-drops-tolerated": "integer"
}
]
}
"psb-briefs": {
"psb-brief": [
{
"destination-port": "integer"
"generic-traffic-spec": {
"tspec-type": "string"
"intsrv-tspec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"g709otn-tspec": {
"traffic-nvc": "integer"
"traffic-multiplier": "integer"
"traffic-bit-rate": "integer"
"traffic-signal-type": "integer"
}
}
"protocol": "integer"
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"session-attribute": {
"reservation-priority": "integer"
"setup-priority": "integer"
"sess-attribute-flags": {
"is-local-protect": "boolean"
"is-node-protect": "boolean"
"is-bandwidth-protect": "boolean"
"is-shared-explicit-requested": "boolean"
"is-record-labels": "boolean"
}
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"source-port": "integer"
"extended-tunnel-id": "string"
"input-interface": "string"
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"traffic-spec": {
"traffic-max-burst": "integer"
"traffic-max-unit": "integer"
"traffic-average-rate": "integer"
"traffic-peak-rate": "integer"
"traffic-min-unit": "integer"
}
"p2mp-id": "integer"
}
]
}
"summary": {
"ls-ps": "integer"
"interfaces": "integer"
"issu-status": {
"role": "string"
"idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
"previous-idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
}
"database-counters": {
"incoming-paths": "integer"
"sessions": "integer"
"interfaces": "integer"
"outgoing-paths": "integer"
"outgoing-reservations": "integer"
"incoming-reservations": "integer"
}
"nsr-status": {
"role": "string"
"idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
"previous-idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
}
}
"issu": {
"status": {
"role": "string"
"idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
"previous-idt-status": {
"withdraw-time": "integer"
"idt-start-time": "integer"
"idt-end-time": "integer"
"declare-time": "integer"
"not-ready-reason": "string"
"sync-status": "string"
}
}
}
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"restart-state": "string"
"neighbor-address": "string"
"global-neighbor-flags": {
"is-application-mpls": "boolean"
"is-application-ouni": "boolean"
}
"lost-communication-reason": [
{
"entry": "string"
}
]
"lost-communication-total": [
{
"entry": "integer"
}
]
"lost-communication-time": [
{
"seconds": "string"
"nanoseconds": "string"
}
]
"is-gr-enabled": "boolean"
"local-node-address": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string"
"nanoseconds": "string"
}
]
"node-address": "string"
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
"bw-pool-info": {
"is-bc1-percent-configured": "boolean"
"max-res-pool-percent": "integer"
"is-bc0-percent-configured": "boolean"
"bc0-percent": "integer"
"bc1-percent": "integer"
"is-max-res-pool-percent-configured": "boolean"
"bandwidth-configuration-model": "string"
}
"request-details": {
"request-detail": [
{
"destination-port": "integer"
"protocol": "integer"
"policy-sources": {
"is-local": "boolean"
"is-cops": "boolean"
"is-cable": "boolean"
"is-default": "boolean"
"is-te-link": "boolean"
}
"source-address": "string"
"sub-group-origin": "string"
"sub-group-id": "integer"
"rsb-key": [
{
"vrfid": "string"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"destination-port-or-tunnel-id": "integer"
"sub-group-id": "integer"
"destination-address": "string"
"session-type": "string"
"p2mp-sub-group-origin": "string"
"p2mp-id": "integer"
"source-port-or-lsp-id": "integer"
}
]
"header": {
"rsvp-version": "integer"
"ip-ttl": "integer"
"ip-tos": "integer"
"rsvp-header-flags": "integer"
"ip-source-address": "string"
"rsvp-message-type": "integer"
"rsvp-ttl": "integer"
}
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-tunnel-id": "string"
}
"ipv4-uni-session": {
"tunnel-id": "integer"
"destination-address": "string"
"extended-address": "string"
}
"session-type": "string"
"ipv4": {
"destination-port": "integer"
"protocol": "integer"
"destination-address": "string"
}
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer"
"p2mp-id": "integer"
"extended-tunnel-id": "string"
}
}
}
"destination-address": "string"
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer"
"flow-signal-type": "integer"
"flow-multiplier": "integer"
"flow-nvc": "integer"
}
"flow-spec-type": "string"
}
"source-port": "integer"
"policy-query-flags": {
"is-bypass": "boolean"
"is-report-required": "boolean"
"is-resync": "boolean"
"is-needed": "boolean"
}
"flow-spec": {
"flow-peak-rate": "integer"
"flow-max-unit": "integer"
"flow-max-burst": "integer"
"flow-requested-rate": "integer"
"flow-average-rate": "integer"
"flow-qos": "string"
"flow-slack": "integer"
"flow-min-unit": "integer"
}
"style": {
"reservation-type": "string"
}
"extended-tunnel-id": "string"
"psb-key": [
{
"vrfid": "string"
"protocol": "integer"
"extended-tunnel-id": "string"
"source-address": "string"
"destination-port-or-tunnel-id": "integer"
"sub-group-id": "integer"
"destination-address": "string"
"session-type": "string"
"p2mp-sub-group-origin": "string"
"p2mp-id": "integer"
"source-port-or-lsp-id": "integer"
}
]
"output-interface": "string"
"req-flags": {
"is-rro-in-path": "boolean"
"is-send-confirm": "boolean"
"is-merge-point": "boolean"
"is-refreshing": "boolean"
"is-ack-outstanding": "boolean"
"is-retransmit": "boolean"
"is-label-request-in-path": "boolean"
"is-nack-received": "boolean"
"is-record-label-in-path": "boolean"
"is-message-id-allocated": "boolean"
"is-paced": "boolean"
"is-local-receiver": "boolean"
}
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
"source-address": "string"
}
"p2mp-ipv4-session": {
"source-port": "integer"
"p2mp-sub-group-origin": "string"
"sub-group-id": "integer"
"source-address": "string"
}
"filter-type": "string"
}
}
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"session-type": "string"
"hop": {
"neighbor-address": "string"
"neighbor-logical-interface-name": "string"
}
"policy-flags": {
"is-installed": "boolean"
"is-accepted": "boolean"
"is-forwarding": "boolean"
}
"p2mp-id": "integer"
}
]
}
"authentication-details": {
"authentication-detail": [
{
"lifetime-left": "integer"
"interface-name": "string"
"source-address": "string"
"key-digest-info": "integer"
"key-status": "integer"
"challenge-status": "string"
"destination-address": "string"
"direction-info": {
"receive-info": {
"sequence-window-size": "integer"
"sequence": "integer"
"sequence-window-count": "integer"
"sequence-window": [
{
"entry": "integer"
}
]
"counters": {
"authentication-received-no-integrity": "integer"
"authentication-received-incomplete": "integer"
"authentication-received-valid-messages": "integer"
"authentication-received-sequence-number-duplicate": "integer"
"authentication-received-sequence-number-outof-range": "integer"
"authentication-received-challenge-timeouts": "integer"
"authentication-received-challenges-response-duplicate": "integer"
"authentication-received-challenges-resent": "integer"
"authentication-received-challenge-response": "integer"
"authentication-received-response-late": "integer"
"authentication-received-challenges-sent": "integer"
"authentication-received-bad-digest": "integer"
"authentication-received-during-challenge": "integer"
"authentication-received-wrong-challenges-response": "integer"
"authentication-received-bad-message-format": "integer"
"authentication-received-wrong-digest-type": "integer"
}
}
"send-info": {
"sequence": "integer"
"counters": {
"authentication-challenge-responses-sent": "integer"
"authentication-sent": "integer"
"authentication-send-challenges-received": "integer"
"authentication-failures": "integer"
}
}
"auth-direction": "string"
}
"lifetime": "integer"
"mode-id": "string"
"auth-compact": {
"neighbor-address": "string"
"direction": "string"
"key-source": "string"
"key-type": "string"
"key-id-valid": "integer"
"destination-address-xr": "string"
"source-address-xr": "string"
"key-id": "integer"
}
}
]
}
"graceful-restart": {
"missed-hellos": "integer"
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"hello-interval": "integer"
"global-neighbors": "integer"
"is-gr-enabled": "boolean"
"local-node-address": [
{
"local-node-ip-address": "string"
"application-type": "string"
}
]
"recovery-time": "integer"
"recovery-timer-exp-time": {
"seconds": "string"
"nanoseconds": "string"
}
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": { RSVP ISSU information
"status": { RSVP ISSU status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": { RSVP ISSU status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
BW-POOL-INFO - Retrieve
Retrieve operation of resource: bw-pool-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bw-pool-info": { All B/W Pool info
"is-bc1-percent-configured": "boolean", Is BC1 default I/F percent configured
"max-res-pool-percent": "integer", Maxium reservable I/F percent B/W
"is-bc0-percent-configured": "boolean", Is BC0 default I/F percent configured
"bc0-percent": "integer", BC0 I/F percent B/W
"bc1-percent": "integer", BC1 I/F percent B/W
"is-max-res-pool-percent-configured": "boolean", Is maximum reservable default I/F percent\nconfigured
"bandwidth-configuration-model": "string" Bandwith configuration model currently in use\n(MAM/RDM)
}
}
PXSB-DETAILS - Retrieve
Retrieve operation of resource: pxsb-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pxsb-details": { Table of detailed PXSB info
{
"destination-port": "integer", The Session Destination Port
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"dynamic-state": "integer", Dynamic State Handle
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"sub-group-id": "integer", Subgroup ID
"source-port": "integer", Source Port
"extended-tunnel-id": "string", Extended Tunnel ID
"input-interface": "string", Path Input Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": { RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
}
}
PXSB-DETAIL - Retrieve
Retrieve operation of resource: pxsb-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-header": { RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
RXSB-DETAILS - Retrieve
Retrieve operation of resource: rxsb-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rxsb-details": { Table of detailed RXSB info
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": { RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
}
}
RXSB-DETAIL - Retrieve
Retrieve operation of resource: rxsb-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-header": { RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-briefs": { Table of brief info about I/F neighbors
{
"neighbor-address": "string", Address of global neighbor
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summaries": { Table of summary info about RSVP-enabled\ncontrollers
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-briefs": { Table for Authentication related information
"authentication-brief": [
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-briefs": { Table of brief info about sessions
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"vrf-name": "string", VRF Name
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detaileds": { Table of detailed info about path state blocks
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean" Outgoing ERO validity
"header": { RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer", RSVP TTL
},
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"policy-source-info": { Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string" Extended Tunnel ID
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string", Time Value in Nano-seconds
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"destination-port": "integer", Destination Port
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"pfc": [
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"output-interface": "string", Output interface
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
]
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string", Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"path-flags": { Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Subgroup ID
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"destination-address": "string", Destination Address
"source-port": "integer", Source Port
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"is-in-ero-valid": "boolean", Incoming ERO validity
"class-type": { DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
]
}
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-flags": { Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-source-info": { Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"class-type": { DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
}
}
PFC - Retrieve
Retrieve operation of resource: pfc
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detaileds": { Table of detailed info about RSVP-enabled\ncontrollers
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
{
"message-id": "string" Message ID
}
]
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"message-ids": "integer", Number of MessageIDs
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer" Number of out-of-band missed messages tolerated
}
]
}
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr-summary": { Fast Re-Route Summary State Information
"reservation-states": { Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": { Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-states": { Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": { Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detaileds": { Table of detailed info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
},
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"input-adjusted-interface": "string", Input Adjusted Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"input-physical-interface": "string", Input Physical Interface
"p2mp-id": "integer", P2MP ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
]
}
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-flags": { Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": { Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": { Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": { Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": { Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": { Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": { Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": { Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summaries": { Table of summary info about RSVP-enabled\ninterfaces
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-briefs": { Table of brief info about hello instances
"hello-instance-brief": [
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-details": { Table for detailed authentication related\ninformation
"authentication-detail": [
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": { direction info
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
},
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": { Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auth-compact": { Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"direction-info": { direction info
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
},
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
},
"auth-direction": "string" AuthDirection
}
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"send-info": { send info
"sequence": "integer", Sequence number
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": { receive info
"sequence-window-size": "integer", Sequence window size
"sequence": "integer", Sequence number
"sequence-window-count": "integer", Sequence window count
"sequence-window": [
{
"entry": "integer"
}
]
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-briefs": { Table of brief info about reservation state\nblocks
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Info
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Info
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
OPEN-CONFIG - Retrieve
Retrieve operation of resource: open-config
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"open-config": { OpenConfig info
"global-counters": { Platform wide RSVP statistics and counters
"out-hello-messages": "integer", Per interface count of hello messages send
"rate-limited-messages": "integer", Global count of rate limited messages
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"in-ack-messages": "integer", Per interface count of ack messages received
"path-timeouts": "integer", Global count of Path Timeouts
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"in-hello-messages": "integer", Per interface count of hello messages received
"reservation-timeouts": "integer", Global count of reservation timeouts
"out-ack-messages": "integer", Per interface count of ack messages send
"in-path-error-messages": "integer", Per interface count of path error messages\nreceived
"out-reservation-error-messages": "integer" Per interface count of reservation error\nmessages send
},
"interface-counters": { Table of info about RSVP-enabled interface\ncounters for OpenConfig
{
"out-ack-messages": "integer", Per interface count of ack messages send
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"interface-name-xr": "string", Interface name
"in-hello-messages": "integer", Per interface count of hello messages received
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-reservation-error-messages": "integer", Per interface count of reservation error\nmessages send
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"interface-name": "string", Interface name
"in-ack-messages": "integer", Per interface count of ack messages received
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"out-hello-messages": "integer", Per interface count of hello messages send
"in-path-error-messages": "integer" Per interface count of path error messages\nreceived
}
]
}
}
}
GLOBAL-COUNTERS - Retrieve
Retrieve operation of resource: global-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-counters": { Platform wide RSVP statistics and counters
"out-hello-messages": "integer", Global count of hello messages send
"rate-limited-messages": "integer", Global count of rate limited messages
"in-reservation-messages": "integer", Global count of reservation messages received
"out-reservation-tear-messages": "integer", Global count of reservation tear messages send
"out-path-tear-messages": "integer", Global count of path tear messages send
"in-ack-messages": "integer", Global count of ack messages received
"path-timeouts": "integer", Global count of Path Timeouts
"in-srefresh-messages": "integer", Global count of srefresh messages received
"in-reservation-tear-messages": "integer", Global count of reservation tear messages\nreceived
"out-path-error-messages": "integer", Global count of path error messages send
"out-reservation-messages": "integer", Global count of reservation messages send
"in-reservation-error-messages": "integer", Global count of reservation error messages\nreceived
"in-path-tear-messages": "integer", Global count of path tear messages received
"out-srefresh-messages": "integer", Global count of srefresh messages send
"out-path-messages": "integer", Global count of path messages send
"in-path-messages": "integer", Global count of path messages received
"in-hello-messages": "integer", Global count of hello messages received
"reservation-timeouts": "integer", Global count of reservation timeouts
"out-ack-messages": "integer", Global count of ack messages send
"in-path-error-messages": "integer", Global count of path error messages received
"out-reservation-error-messages": "integer" Global count of reservation error messages send
}
}
INTERFACE-COUNTERS - Retrieve
Retrieve operation of resource: interface-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-counters": { Table of info about RSVP-enabled interface\ncounters for OpenConfig
{
"out-ack-messages": "integer", Per interface count of ack messages send
"in-reservation-messages": "integer", Per interface count of reservation messages\nreceived
"in-srefresh-messages": "integer", Per interface count of srefresh messages\nreceived
"in-path-tear-messages": "integer", Per interface count of path tear messages\nreceived
"interface-name-xr": "string", Interface name
"in-hello-messages": "integer", Per interface count of hello messages received
"out-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nsend
"out-reservation-error-messages": "integer", Per interface count of reservation error\nmessages send
"in-reservation-tear-messages": "integer", Per interface count of reservation tear messages\nreceived
"out-path-tear-messages": "integer", Per interface count of path tear messages send
"interface-name": "string", Interface name
"in-ack-messages": "integer", Per interface count of ack messages received
"out-path-error-messages": "integer", Per interface count of path error messages send
"out-reservation-messages": "integer", Per interface count of reservation messages send
"in-reservation-error-messages": "integer", Per interface count of reservation error\nmessages received
"out-srefresh-messages": "integer", Per interface count of srefresh messages send
"out-path-messages": "integer", Per interface count of path messages send
"in-path-messages": "integer", Per interface count of path messages received
"out-hello-messages": "integer", Per interface count of hello messages send
"in-path-error-messages": "integer" Per interface count of path error messages\nreceived
}
]
}
}
INTERFACE-COUNTER - Retrieve
Retrieve operation of resource: interface-counter
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": { Counters
"interface-messages": { Table of message counters
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": { Summary information for all RSVP message\ncounters
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": { Table containing event sync counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"database": { Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Table of interface specific out of resource\ncounters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": { Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": { Prefix filtering counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": { Event counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"nsr": { Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": { Out of resource counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": { Table of message counters
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-summary": { Summary information for all RSVP message\ncounters
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": { Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": { Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": { Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": { Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-filtering": { Prefix filtering counters
"interfaces": { Table of interface specific prefix filtering\ncounters
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"accesses": { AccessList specific prefix filtering counters
{
"access-list-name": "string", AccessList Name
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
ACCESS - Retrieve
Retrieve operation of resource: access
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific prefix filtering\ncounters
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific prefix filtering\ncounters
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": { Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": { Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": { Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": { Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": { Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": { Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-of-resource": { Out of resource counters
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific out of resource\ncounters
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": { Table of interface specific out of resource\ncounters
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-events": { Event counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": { Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": { Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database": { Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-syncs": { Table containing event sync counters
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detaileds": { Table of detailed info about RSVP-enabled\ninterfaces
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
{
"message-id": "string" Message ID
}
]
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"message-ids": "integer", Number of MessageIDs
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer" Number of out-of-band missed messages tolerated
}
]
}
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": { Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-briefs": { Table of brief info about RSVP-enabled\ncontroller
{
"controller-name": "string", Controller Name
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart": { Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer" Recovery time (milliseconds)
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string", Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-briefs": { Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-details": { Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [
{
"last-message-sent-time": { Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": { Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-details": { Table of detailed info about I/F neighbors
{
"neighbor-address": "string", Address of global neighbor
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": { RSVP NSR information
"status": { RSVP NSR status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": { RSVP NSR status information
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": { RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Number of Interfaces
"issu-status": { Issu status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": { All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": { NSR status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu-status": { Issu status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-status": { NSR status
"role": "string", Process role
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": { IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": { Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-counters": { All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
FRRS - Retrieve
Retrieve operation of resource: frrs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frrs": { Table of detailed info about Fast Re-route\nstates
"frr": [
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"sub-group-id": "integer", Subgroup ID
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer", P2MP ID
"reservation-status": "string", RSVP FRR Reservation States
"source-port": "integer" Source Port
}
]
}
}
FRR - Retrieve
Retrieve operation of resource: frr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-briefs": { Table of brief info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-details": { Table of detail info about requests
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
]
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer", RSVP TTL
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
}
}
},
"destination-address": "string", Destination address
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"output-interface": "string" output Interface
"req-flags": { Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean", Local Receiver
},
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec Information
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": { RSVP Filter
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": { RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"req-flags": { Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
}
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": { Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": { RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": { RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": { RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": { RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-briefs": { Table of brief info about RSVP-enabled\ninterfaces
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": { Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": { Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": { Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detaileds": { Table of detailed info about sessions
{
"destination-port": "integer", The Session Destination Port
"compact": { Compact session data
"rs-bs": "integer", Number of reservation state block states
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { IPV4 ASSOCIATION Object
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer" Number of elements in detail list
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
{
{
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Unnumbered Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string" Point to Multipoint SubGroup Origin
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string" TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer", Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"lsp-wrap-label": "string", LSP Wrap Label
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": { Protection object
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": { Association object
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": { IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": { IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": { Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
},
"reverse-lsp": { Reverse LSP object
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{,
"entry": "integer"
}
]
}
]
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"traffic-spec": { Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"lsp-id": "integer" LSP ID
}
]
"rsb-info": [
{
"generic-out-label": { Generic Label for outbound traffic
"generic-label-type": "string" GenericLabelType
"generalized-label": { Generalized Label
"value": [
{,
"entry": "integer"
}
]
}
},
"flow-spec": { Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"out-interface": "string", Interface on which outbound message was sent
"is-valid": "boolean", Entry validity
"backup-interface": "string", Backup tunnel interface
"rro": [
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": { Label RRO Sub Object
"variable-length-label": [
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Unnumbered Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string" Label for outbound traffic
"generic-flow-spec": { Generic Flow Spec object
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer", G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
]
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
"vrf-name": "string"
"destination-address": "string"
"session-type": "string"
"p2mp-id": "integer"
}
]
}
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
COMPACT - Retrieve
Retrieve operation of resource: compact
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": { Compact session data
"rs-bs": "integer", Number of reservation state block states
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer" Number of elements in detail list
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-in-label": { Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"association": { Association object
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
"extended-id": [
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
"ipv4": {
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
"association-type": "string"
"ipv6": {
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6": { IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": { EXTENDED IPV4 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV4 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv6": { EXTENDED IPV6 ASSOCIATION Object
{
"entry": "integer"
}
]
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protection": { Protection object
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsp-flags": { PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": { PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
}
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reverse-lsp": { Reverse LSP object
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
]
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{,
"entry": "integer"
}
]
}
]
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": { IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": { Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": { Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": { Generalized Label
"value": [
{
"entry": "integer"
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": { Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": { Generic Flow Spec object
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": { G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": { IPV4 RRO Sub Object
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": { Label RRO Sub Object
{
"entry": "integer"
}
]
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": { Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": { The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": { SRLG RRO Sub Object
{
"entry": "integer"
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-details": { Table of detailed info about hello instances
"hello-instance-detail": [
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"up-time": { Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": { Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": { Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-time": { Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-details": { Table of detailed info about global neighbors
{
"restart-state": "string", Current restart state
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"hello-interval": "integer", Hello Interval (milliseconds)
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [
{
"entry": "string"
}
]
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [
{
"entry": "string"
}
]
"up-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"restart-timer-expiry-time": {
"seconds": "string"
"nanoseconds": "string"
}
"restart-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"neighbor-address": "string"
"missed-hellos": "integer"
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
]
"recovery-time-left": {
"seconds": "string"
"nanoseconds": "string"
}
"recovery-time": "integer"
"node-address": "string"
"is-restart-timer-running": "boolean"
"neighbor-hello-state": [
{
"entry": "string"
}
]
"pending-states": "integer"
"is-recovery-timer-running": "boolean"
"restart-time": "integer"
}
]
}
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-time-left": { How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-timer-expiry-time": { When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": { How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": { Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-briefs": { Table of brief info about path state blocks
{
"destination-port": "integer", The Session Destination Port
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", Session Type
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"source-port": "integer", Source Port
"extended-tunnel-id": "string", Extended Tunnel ID
"input-interface": "string", Path Input Interface
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": { RSVP Session Information
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": { RSVP Session
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"session-type": "string", SessionType
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": { UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": { IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": { IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": { IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": { RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": { RSVP Template
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": { RSVP Filter
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": { UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": { IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": { RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": { Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": { RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": { RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": { G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": { Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-briefs": { Table of brief info about global neighbors
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
{
"entry": "string"
}
]
{
"entry": "integer"
}
]
"lost-communication-time": [
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean" Is GR enabled
"local-node-address": [
{,
"entry": "string"
}
]
"up-time": [
{,
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string" Neighbor node address
"neighbor-hello-state": [
{,
"entry": "string"
}
]
}
]
}
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": { Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
}